<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>bn::color class | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span>color <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__color_8h.html">&lt;bn_color.h&gt;</a></div>
        </h1>
        <p>Defines a color in the GBA format (15 bits BGR).</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
                <li><a href="#friends">Friends</a></li>
              </ul>
            </li>
          </ul>
        </nav>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt id="a15c47e5737c1e9e8fb5b51c05db0ccd6">
              <span class="m-doc-wrap-bumper"><a href="#a15c47e5737c1e9e8fb5b51c05db0ccd6" class="m-doc-self">color</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">defaulted</span> <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Default constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#a6ae933d2a801fcac99c72706e752560d" class="m-doc">color</a>(</span><span class="m-doc-wrap">int data) <span class="m-label m-flat m-info">explicit</span>  <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#af6ab58164001d62660f6dbb478df9b30" class="m-doc">color</a>(</span><span class="m-doc-wrap">int red,
              int green,
              int blue) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Constructor.</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt id="a7acdaee2a8ff3aedd7a1e971de129c99">
              <span class="m-doc-wrap-bumper">auto <a href="#a7acdaee2a8ff3aedd7a1e971de129c99" class="m-doc-self">data</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the representation of this color in GBA format.</dd>
            <dt id="a1cbd34660772f826c5ed29cfc9c1af22">
              <span class="m-doc-wrap-bumper">void <a href="#a1cbd34660772f826c5ed29cfc9c1af22" class="m-doc-self">set_data</a>(</span><span class="m-doc-wrap">int data) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Sets the representation of this color in GBA format.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a67851c4a2089ba9a0cd377342b6bd21a" class="m-doc">set_components</a>(</span><span class="m-doc-wrap">int red,
              int green,
              int blue) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Sets all the components of this color.</dd>
            <dt id="a52c56cbf02d6cc31e5f3e8de0eba1575">
              <span class="m-doc-wrap-bumper">auto <a href="#a52c56cbf02d6cc31e5f3e8de0eba1575" class="m-doc-self">red</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the red component.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ae63d869505574fa37396ebf468d55352" class="m-doc">set_red</a>(</span><span class="m-doc-wrap">int red) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Sets the red component.</dd>
            <dt id="a2036c603414c5a47c3c2bf56596dacab">
              <span class="m-doc-wrap-bumper">auto <a href="#a2036c603414c5a47c3c2bf56596dacab" class="m-doc-self">green</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the green component.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#aecb67bcad4ac9b8adea91c5301a2143f" class="m-doc">set_green</a>(</span><span class="m-doc-wrap">int green) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Sets the green component.</dd>
            <dt id="a30c6a701614eec0d6866ecca1d6b22b4">
              <span class="m-doc-wrap-bumper">auto <a href="#a30c6a701614eec0d6866ecca1d6b22b4" class="m-doc-self">blue</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the blue component.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#af1fde7f97c5a5cbf21d708f989ccd504" class="m-doc">set_blue</a>(</span><span class="m-doc-wrap">int blue) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Sets the blue component.</dd>
          </dl>
        </section>
        <section id="friends">
          <h2><a href="#friends">Friends</a></h2>
          <dl class="m-doc">
            <dt id="a0f49de9c370822bc353002fdab199443">
              <span class="m-doc-wrap-bumper">auto <a href="#a0f49de9c370822bc353002fdab199443" class="m-doc-self">operator==</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1color.html" class="m-doc">color</a> a,
              <a href="classbn_1_1color.html" class="m-doc">color</a> b) -&gt; bool <span class="m-label m-flat m-info">defaulted</span> <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Default equal operator.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="a6ae933d2a801fcac99c72706e752560d"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />color::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a6ae933d2a801fcac99c72706e752560d" class="m-doc-self">color</a>(</span><span class="m-doc-wrap">int data) <span class="m-label m-info">explicit</span>  <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">data</td>
                  <td>Color value in GBA format.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="af6ab58164001d62660f6dbb478df9b30"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />color::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af6ab58164001d62660f6dbb478df9b30" class="m-doc-self">color</a>(</span><span class="m-doc-wrap">int red,
              int green,
              int blue) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">red</td>
                  <td>Red component, in the range [0..31].</td>
                </tr>
                <tr>
                  <td>green</td>
                  <td>Green component, in the range [0..31].</td>
                </tr>
                <tr>
                  <td>blue</td>
                  <td>Blue component, in the range [0..31].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a67851c4a2089ba9a0cd377342b6bd21a"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />color::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a67851c4a2089ba9a0cd377342b6bd21a" class="m-doc-self">set_components</a>(</span><span class="m-doc-wrap">int red,
              int green,
              int blue) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Sets all the components of this color.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">red</td>
                  <td>Red component, in the range [0..31].</td>
                </tr>
                <tr>
                  <td>green</td>
                  <td>Green component, in the range [0..31].</td>
                </tr>
                <tr>
                  <td>blue</td>
                  <td>Blue component, in the range [0..31].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="ae63d869505574fa37396ebf468d55352"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />color::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae63d869505574fa37396ebf468d55352" class="m-doc-self">set_red</a>(</span><span class="m-doc-wrap">int red) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Sets the red component.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">red</td>
                  <td>Red component, in the range [0..31].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="aecb67bcad4ac9b8adea91c5301a2143f"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />color::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aecb67bcad4ac9b8adea91c5301a2143f" class="m-doc-self">set_green</a>(</span><span class="m-doc-wrap">int green) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Sets the green component.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">green</td>
                  <td>Green component, in the range [0..31].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="af1fde7f97c5a5cbf21d708f989ccd504"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />color::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af1fde7f97c5a5cbf21d708f989ccd504" class="m-doc-self">set_blue</a>(</span><span class="m-doc-wrap">int blue) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Sets the blue component.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">blue</td>
                  <td>Blue component, in the range [0..31].</td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
